/**
 * Copyright (c) 2010 Basil Shikin, BugStat Project
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.bugstat.common.utils;


/**
 * This is a progress listener that is split into a number of fractions. 
 * 
 * @author Basil Shikin
 *
 */
public class FractionedProgressListener
    implements ProgressListener
{
    private final ProgressListener rootListener;

    private final int totalOperations;
        
    private int currentOperationPercentage = 0;
    private int currentOperationNumber     = 0;
    
    /**
     * Create new fractioned progress listener
     * 
     * @param rootListener      Root listener to notify. Must not be null
     * @param totalOperations   Total fractions (operations). Must be greater then zero.
     */
    public FractionedProgressListener( final ProgressListener rootListener, int totalOperations )
    {
        // Check input
        if (totalOperations < 1)  throw new IllegalArgumentException("Invalid number of total operations specified: " + totalOperations );
        
        this.rootListener    = rootListener;
        this.totalOperations = totalOperations;
    }

    
    @Override
    public void progressReported(int progress)
    {
        currentOperationPercentage = progress;
        
        final int totalPercent = currentOperationNumber*100 + currentOperationPercentage;
        if ( rootListener != null ) rootListener.progressReported( totalPercent/totalOperations );
        
        if ( progress == 100 )
        {
            currentOperationNumber++;
        }
    }
}
